document StreamLimitReachedError when attempting to open streams #95
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to reflect that OpenStream now returns a StreamLimitReachedError instead of a net.Error and adjusts the example error check accordingly.
- Update prose to mention
quic.StreamLimitReachedErrorrather than anet.Errortimeout - Update example code to use
errors.Isagainstquic.StreamLimitReachedError
Comments suppressed due to low confidence (2)
content/docs/quic/streams.md:49
- [nitpick] The phrase 'quic.StreamLimitReachedError error' is redundant; consider writing 'returns a *quic.StreamLimitReachedError' or simply 'returns StreamLimitReachedError'.
`OpenStream` attempts to open a new bidirectional stream (`quic.Stream`), and it never blocks. If it's currently not possible to open a new stream, it returns a `quic.StreamLimitReachedError` error:
content/docs/quic/streams.md:53
- Using
errors.Iswith a newly instantiated pointer won't match the returned error instance. Consider usingerrors.Asto match the error type, for example:
var e *quic.StreamLimitReachedError
if errors.As(err, &e) {
// handle stream limit reached
}if errors.Is(err, &quic.StreamLimitReachedError{}) {
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of quic-go/quic-go#5060, this is not a
net.Erroranymore.